home *** CD-ROM | disk | FTP | other *** search
/ Sprite 1984 - 1993 / Sprite 1984 - 1993.iso / src / cmds / dump / dump.man < prev    next >
Encoding:
Text File  |  1991-11-22  |  5.3 KB  |  139 lines
  1. ' $Header: /sprite/src/admin/dump/RCS/dump.man,v 1.4 91/11/22 14:09:23 jhh Exp $ SPRITE (Berkeley)
  2. .so \*(]ltmac.sprite
  3. .HS DUMP cmds
  4. .BS
  5. .SH NAME
  6. dump \- A program that dumps directories
  7. .SH SYNOPSIS
  8. \fBdump\fR [\fIoptions\fR] \fIdirectory\fR
  9. .SH OPTIONS
  10. .IP "\fB\-a \fR" 15
  11. Reset access times after dumping each file.
  12. .IP "\fB\-f  \fIfilename\fR" 15
  13. Use \fIfilename\fR as the name of the dump archive.
  14. .IP "\fB\-help \fR" 15
  15. Print a help message.
  16. .IP "\fB\-i number \fR" 15
  17. Initialize the tape, using \fBnumber\fR for the label.
  18. .IP "\fB\-l  \fIdigit\fR" 15
  19. The single digit in the range 0-9 specifies the dump level.  The default
  20. is zero.
  21. .IP "\fB\-m \fIusername\fR" 15
  22. Send mail to \fIusername\fR to report a fatal error, or successful completion.
  23. .IP "\fB\-r\fR" 15
  24. Re-initialize the tape.  Any data on the tape is lost.
  25. .IP "\fB\-s\fR" 15
  26. Safe re-initialization of tape.  The reinitialization will fail if the
  27. tape has been recently used.
  28. .IP "\fB\-t \fR" 15
  29. Print the dump archive table of contents.
  30. .IP "\fB\-v \fR" 15
  31. Verbose.  The name of each file is listed as it is dumped.
  32. .IP "\fB\-u \fR" 15
  33. Unofficial dump.  The dump is not recorded in the dumpdates file.
  34. .BE
  35.  
  36. .SH INTRODUCTION
  37. .PP
  38. The \fBdump\fR command is used to do an incremental dump of a
  39. set of directory.  It will recursively dump all files and
  40. subdirectories.  Each file that has been created or modified
  41. since the last lower level dump will
  42. be copied to the archive file.  For example, the command
  43. .DS
  44. dump -l 2 -f /dev/tape0 /sprite
  45.  
  46. .DE
  47. will dump all files in the directory \fB/sprite\fR
  48. in tar format, to \fB/dev/tape0\fR.
  49. .SH TAPE FORMAT
  50. .PP
  51. Dump tapes have a particular format. It is assumed that blocks on the
  52. tape cannot be overwritten, so the tape is written in an append-only fashion.
  53. When a tape is initialized a file called the tape \fIlabel\fP is written
  54. at the beginning of the tape.  
  55. Each time a filesystem is dumped a new updated tape label is written to
  56. the end of the tape, so that the current tape label is always the last
  57. one on the tape.  
  58. The tape label is 16 Kbytes in size, and
  59. consists of a sequence of ASCII strings separated by newlines.  The 
  60. first string is of the form
  61. .DS
  62. SPRITE DUMP TAPE, Version \fIv\fP Level \fIx\fP Tape \fIn\fP
  63.  
  64. .DE
  65. where \fIv\fP is the version of \fBdump\fP that wrote the tape,
  66. \fBx\fP is the level of the dump tape, and \fBn\fP is the dump tape number.
  67. The version is intended to allow future versions of \fBdump\fP to be 
  68. backwards compatible.
  69. The level is filled in when the tape is initialized, but is otherwise
  70. unused.  It could be used by \fBdump\fP and higher-level software to 
  71. automate the dumping process.
  72. .PP
  73. Subsequent lines in the tape label contain a table of contents for the tape,
  74. and are of the form
  75. .DS
  76. \fITapeNum FileNum MBDumped MBLeft Date FileSystem\fP
  77.  
  78. .DE
  79. where \fITapeNum\fP is the tape number, \fIFileNum\fP is the file number
  80. on tape corresponding to the current entry (starting with 1), 
  81. \fIMBDumped\fP is the number of MBytes dumped from the filesystem,
  82. \fIMBLeft\fP is the number of MBytes remaining on the tape after
  83. the filesystem was dumped, \fIDate\fP is the date when the filesystem was
  84. dumped, and \fIFileSystem\fP
  85. is the name of the filesystem that was dumped.
  86. .SH FILES
  87. .TP
  88. \fB/sprite/admin/dump/dumpdates\fP
  89. When a dump completes the information that is written into the tape label
  90. is also written into this file.
  91. Each line is of the form
  92. .sp
  93. \fITapeNum FileNum MBDumped MBLeft Date FileSystem\fP
  94. .sp
  95. .SP
  96. where \fITapeNum\fP is the tape number, \fIFileNum\fP is the file number
  97. on tape corresponding to the current entry (starting with 1), 
  98. \fIMBDumped\fP is the number of MBytes dumped from the filesystem,
  99. \fIMBLeft\fP is the number of MBytes remaining on the tape after
  100. the filesystem was dumped, \fIDate\fP is the date when the filesystem was
  101. dumped, and \fIFileSystem\fP
  102. is the name of the filesystem that was dumped.
  103. .TP
  104. \fB/sprite/admin/dump/dumplog\fP
  105. This file contains low-level debugging information that is printed out by
  106. \fBdump\fP as it runs.
  107. .TP
  108. \fB/sprite/admin/dump/statuslog\fP
  109. This file contains information about the status of both the tape drives
  110. and the tapes.
  111. A line is added to the file each time a dump completes, and is of the form
  112. .sp
  113. \fIDriveType Serial TapeNum MBDumped ErrorRate Date Device\fP
  114. .sp
  115. .SP
  116. \fIDriveType\fP is the type of drive that was used (e.g. EXB-8500).
  117. \fISerial\fP is the serial number of the drive.  
  118. The combination of the drive type
  119. and serial number should allow tape drives to be uniquely identified.
  120. \fITapeNumber\fP is the number of the tape that was used.
  121. \fIMBDumped\fP is the number of MBytes that were dumped. 
  122. \fIErrorRate\fP is the number of errors per tape access, expressed as
  123. a percentage of tape accesses.
  124. An error rate of 100% means that there was an average of one error per
  125. tape access.
  126. The definition of an error is vendor specific
  127. but an increase in the error rate over time may indicate that a tape is
  128. wearing out or that a drive needs servicing.
  129. The \fIDate\fP is the date on which the dump occurred,
  130. and the \fIDevice\fP is the name of the device as passed to the
  131. \fBdump\fP command.
  132. The latter should not be considered to uniquely identify a tape drive
  133. since the mapping between the device name and the device can change,
  134. thus the drive type and serial number should be used to look for 
  135. an increasing error rate on a particular drive.
  136. .SH KEYWORDS
  137. dump, restore, tape, backup, tar
  138.  
  139.